<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html lang="en">

<head>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  <title>LCOV - lcov.info.p - core/contracts/protocol/tokenization/base/src/core/contracts/protocol/tokenization/base/ScaledBalanceTokenBase.sol</title>
  <link rel="stylesheet" type="text/css" href="../../../../../../../../../../../gcov.css">
</head>

<body>

          <table width="100%" border=0 cellspacing=0 cellpadding=0>
            <tr><td class="title">LCOV - code coverage report</td></tr>
            <tr><td class="ruler"><img src="../../../../../../../../../../../glass.png" width=3 height=3 alt=""></td></tr>

            <tr>
              <td width="100%">
                <table cellpadding=1 border=0 width="100%">
          <tr>
            <td width="10%" class="headerItem">Current view:</td>
            <td width="10%" class="headerValue"><a href="../../../../../../../../../../../index.html">top level</a> - <a href="index.html">core/contracts/protocol/tokenization/base/src/core/contracts/protocol/tokenization/base</a> - ScaledBalanceTokenBase.sol<span style="font-size: 80%;"> (source / <a href="ScaledBalanceTokenBase.sol.func-c.html">functions</a>)</span></td>
            <td width="5%"></td>
            <td width="5%"></td>
            <td width="5%" class="headerCovTableHead">Coverage</td>
            <td width="5%" class="headerCovTableHead" title="Covered + Uncovered code">Total</td>
            <td width="5%" class="headerCovTableHead" title="Exercised code only">Hit</td>
          </tr>
          <tr>
            <td class="headerItem">Test:</td>
            <td class="headerValue">lcov.info.p</td>
            <td></td>
            <td class="headerItem">Lines:</td>
            <td class="headerCovTableEntryHi">100.0&nbsp;%</td>
            <td class="headerCovTableEntry">45</td>
            <td class="headerCovTableEntry">45</td>
          </tr>
          <tr>
            <td class="headerItem">Test Date:</td>
            <td class="headerValue">2024-04-09 14:12:28</td>
            <td></td>
            <td class="headerItem">Functions:</td>
            <td class="headerCovTableEntryHi">100.0&nbsp;%</td>
            <td class="headerCovTableEntry">7</td>
            <td class="headerCovTableEntry">7</td>
          </tr>
          <tr>
            <td></td>
            <td></td>
            <td></td>
            <td class="headerItem">Branches:</td>
            <td class="headerCovTableEntryHi">-</td>
            <td class="headerCovTableEntry">0</td>
            <td class="headerCovTableEntry">0</td>
          </tr>
                  <tr><td><img src="../../../../../../../../../../../glass.png" width=3 height=3 alt=""></td></tr>
                </table>
              </td>
            </tr>

            <tr><td class="ruler"><img src="../../../../../../../../../../../glass.png" width=3 height=3 alt=""></td></tr>
          </table>

          <table cellpadding=0 cellspacing=0 border=0>
            <tr>
              <td><br></td>
            </tr>
            <tr>
              <td>
<pre class="sourceHeading">             Branch data     Line data    Source code</pre>
<pre class="source">
<span id="L1"><span class="lineNum">       1</span>                 :             : // SPDX-License-Identifier: MIT</span>
<span id="L2"><span class="lineNum">       2</span>                 :             : pragma solidity ^0.8.10;</span>
<span id="L3"><span class="lineNum">       3</span>                 :             : </span>
<span id="L4"><span class="lineNum">       4</span>                 :             : import {SafeCast} from '../../../dependencies/openzeppelin/contracts/SafeCast.sol';</span>
<span id="L5"><span class="lineNum">       5</span>                 :             : import {Errors} from '../../libraries/helpers/Errors.sol';</span>
<span id="L6"><span class="lineNum">       6</span>                 :             : import {WadRayMath} from '../../libraries/math/WadRayMath.sol';</span>
<span id="L7"><span class="lineNum">       7</span>                 :             : import {IPool} from '../../../interfaces/IPool.sol';</span>
<span id="L8"><span class="lineNum">       8</span>                 :             : import {IScaledBalanceToken} from '../../../interfaces/IScaledBalanceToken.sol';</span>
<span id="L9"><span class="lineNum">       9</span>                 :             : import {MintableIncentivizedERC20} from './MintableIncentivizedERC20.sol';</span>
<span id="L10"><span class="lineNum">      10</span>                 :             : </span>
<span id="L11"><span class="lineNum">      11</span>                 :             : /**</span>
<span id="L12"><span class="lineNum">      12</span>                 :             :  * @title ScaledBalanceTokenBase</span>
<span id="L13"><span class="lineNum">      13</span>                 :             :  * @author Aave</span>
<span id="L14"><span class="lineNum">      14</span>                 :             :  * @notice Basic ERC20 implementation of scaled balance token</span>
<span id="L15"><span class="lineNum">      15</span>                 :             :  */</span>
<span id="L16"><span class="lineNum">      16</span>                 :             : abstract contract ScaledBalanceTokenBase is MintableIncentivizedERC20, IScaledBalanceToken {</span>
<span id="L17"><span class="lineNum">      17</span>                 :             :   using WadRayMath for uint256;</span>
<span id="L18"><span class="lineNum">      18</span>                 :             :   using SafeCast for uint256;</span>
<span id="L19"><span class="lineNum">      19</span>                 :             : </span>
<span id="L20"><span class="lineNum">      20</span>                 :             :   /**</span>
<span id="L21"><span class="lineNum">      21</span>                 :             :    * @dev Constructor.</span>
<span id="L22"><span class="lineNum">      22</span>                 :             :    * @param pool The reference to the main Pool contract</span>
<span id="L23"><span class="lineNum">      23</span>                 :             :    * @param name The name of the token</span>
<span id="L24"><span class="lineNum">      24</span>                 :             :    * @param symbol The symbol of the token</span>
<span id="L25"><span class="lineNum">      25</span>                 :             :    * @param decimals The number of decimals of the token</span>
<span id="L26"><span class="lineNum">      26</span>                 :             :    */</span>
<span id="L27"><span class="lineNum">      27</span>                 :             :   constructor(</span>
<span id="L28"><span class="lineNum">      28</span>                 :             :     IPool pool,</span>
<span id="L29"><span class="lineNum">      29</span>                 :             :     string memory name,</span>
<span id="L30"><span class="lineNum">      30</span>                 :             :     string memory symbol,</span>
<span id="L31"><span class="lineNum">      31</span>                 :             :     uint8 decimals</span>
<span id="L32"><span class="lineNum">      32</span>                 :             :   ) MintableIncentivizedERC20(pool, name, symbol, decimals) {</span>
<span id="L33"><span class="lineNum">      33</span>                 :             :     // Intentionally left blank</span>
<span id="L34"><span class="lineNum">      34</span>                 :             :   }</span>
<span id="L35"><span class="lineNum">      35</span>                 :             : </span>
<span id="L36"><span class="lineNum">      36</span>                 :             :   /// @inheritdoc IScaledBalanceToken</span>
<span id="L37"><span class="lineNum">      37</span>                 :<span class="tlaGNC tlaBgGNC">       52893 :   function scaledBalanceOf(address user) external view override returns (uint256) {</span></span>
<span id="L38"><span class="lineNum">      38</span>                 :<span class="tlaGNC">      158679 :     return super.balanceOf(user);</span></span>
<span id="L39"><span class="lineNum">      39</span>                 :             :   }</span>
<span id="L40"><span class="lineNum">      40</span>                 :             : </span>
<span id="L41"><span class="lineNum">      41</span>                 :             :   /// @inheritdoc IScaledBalanceToken</span>
<span id="L42"><span class="lineNum">      42</span>                 :<span class="tlaGNC">          21 :   function getScaledUserBalanceAndSupply(</span></span>
<span id="L43"><span class="lineNum">      43</span>                 :             :     address user</span>
<span id="L44"><span class="lineNum">      44</span>                 :             :   ) external view override returns (uint256, uint256) {</span>
<span id="L45"><span class="lineNum">      45</span>                 :<span class="tlaGNC">          42 :     return (super.balanceOf(user), super.totalSupply());</span></span>
<span id="L46"><span class="lineNum">      46</span>                 :             :   }</span>
<span id="L47"><span class="lineNum">      47</span>                 :             : </span>
<span id="L48"><span class="lineNum">      48</span>                 :             :   /// @inheritdoc IScaledBalanceToken</span>
<span id="L49"><span class="lineNum">      49</span>                 :<span class="tlaGNC">       51717 :   function scaledTotalSupply() public view virtual override returns (uint256) {</span></span>
<span id="L50"><span class="lineNum">      50</span>                 :<span class="tlaGNC">      215571 :     return super.totalSupply();</span></span>
<span id="L51"><span class="lineNum">      51</span>                 :             :   }</span>
<span id="L52"><span class="lineNum">      52</span>                 :             : </span>
<span id="L53"><span class="lineNum">      53</span>                 :             :   /// @inheritdoc IScaledBalanceToken</span>
<span id="L54"><span class="lineNum">      54</span>                 :<span class="tlaGNC">          39 :   function getPreviousIndex(address user) external view virtual override returns (uint256) {</span></span>
<span id="L55"><span class="lineNum">      55</span>                 :<span class="tlaGNC">          78 :     return _userState[user].additionalData;</span></span>
<span id="L56"><span class="lineNum">      56</span>                 :             :   }</span>
<span id="L57"><span class="lineNum">      57</span>                 :             : </span>
<span id="L58"><span class="lineNum">      58</span>                 :             :   /**</span>
<span id="L59"><span class="lineNum">      59</span>                 :             :    * @notice Implements the basic logic to mint a scaled balance token.</span>
<span id="L60"><span class="lineNum">      60</span>                 :             :    * @param caller The address performing the mint</span>
<span id="L61"><span class="lineNum">      61</span>                 :             :    * @param onBehalfOf The address of the user that will receive the scaled tokens</span>
<span id="L62"><span class="lineNum">      62</span>                 :             :    * @param amount The amount of tokens getting minted</span>
<span id="L63"><span class="lineNum">      63</span>                 :             :    * @param index The next liquidity index of the reserve</span>
<span id="L64"><span class="lineNum">      64</span>                 :             :    * @return `true` if the the previous balance of the user was 0</span>
<span id="L65"><span class="lineNum">      65</span>                 :             :    */</span>
<span id="L66"><span class="lineNum">      66</span>                 :<span class="tlaGNC">       21697 :   function _mintScaled(</span></span>
<span id="L67"><span class="lineNum">      67</span>                 :             :     address caller,</span>
<span id="L68"><span class="lineNum">      68</span>                 :             :     address onBehalfOf,</span>
<span id="L69"><span class="lineNum">      69</span>                 :             :     uint256 amount,</span>
<span id="L70"><span class="lineNum">      70</span>                 :             :     uint256 index</span>
<span id="L71"><span class="lineNum">      71</span>                 :             :   ) internal returns (bool) {</span>
<span id="L72"><span class="lineNum">      72</span>                 :<span class="tlaGNC">       65091 :     uint256 amountScaled = amount.rayDiv(index);</span></span>
<span id="L73"><span class="lineNum">      73</span>                 :<span class="tlaGNC">       43394 :     require(amountScaled != 0, Errors.INVALID_MINT_AMOUNT);</span></span>
<span id="L74"><span class="lineNum">      74</span>                 :             : </span>
<span id="L75"><span class="lineNum">      75</span>                 :<span class="tlaGNC">       65088 :     uint256 scaledBalance = super.balanceOf(onBehalfOf);</span></span>
<span id="L76"><span class="lineNum">      76</span>                 :<span class="tlaGNC">       86784 :     uint256 balanceIncrease = scaledBalance.rayMul(index) -</span></span>
<span id="L77"><span class="lineNum">      77</span>                 :<span class="tlaGNC">       43392 :       scaledBalance.rayMul(_userState[onBehalfOf].additionalData);</span></span>
<span id="L78"><span class="lineNum">      78</span>                 :             : </span>
<span id="L79"><span class="lineNum">      79</span>                 :<span class="tlaGNC">       43392 :     _userState[onBehalfOf].additionalData = index.toUint128();</span></span>
<span id="L80"><span class="lineNum">      80</span>                 :             : </span>
<span id="L81"><span class="lineNum">      81</span>                 :<span class="tlaGNC">       43392 :     _mint(onBehalfOf, amountScaled.toUint128());</span></span>
<span id="L82"><span class="lineNum">      82</span>                 :             : </span>
<span id="L83"><span class="lineNum">      83</span>                 :<span class="tlaGNC">       65088 :     uint256 amountToMint = amount + balanceIncrease;</span></span>
<span id="L84"><span class="lineNum">      84</span>                 :<span class="tlaGNC">       43392 :     emit Transfer(address(0), onBehalfOf, amountToMint);</span></span>
<span id="L85"><span class="lineNum">      85</span>                 :<span class="tlaGNC">       43392 :     emit Mint(caller, onBehalfOf, amountToMint, balanceIncrease, index);</span></span>
<span id="L86"><span class="lineNum">      86</span>                 :             : </span>
<span id="L87"><span class="lineNum">      87</span>                 :<span class="tlaGNC">       43392 :     return (scaledBalance == 0);</span></span>
<span id="L88"><span class="lineNum">      88</span>                 :             :   }</span>
<span id="L89"><span class="lineNum">      89</span>                 :             : </span>
<span id="L90"><span class="lineNum">      90</span>                 :             :   /**</span>
<span id="L91"><span class="lineNum">      91</span>                 :             :    * @notice Implements the basic logic to burn a scaled balance token.</span>
<span id="L92"><span class="lineNum">      92</span>                 :             :    * @dev In some instances, a burn transaction will emit a mint event</span>
<span id="L93"><span class="lineNum">      93</span>                 :             :    * if the amount to burn is less than the interest that the user accrued</span>
<span id="L94"><span class="lineNum">      94</span>                 :             :    * @param user The user which debt is burnt</span>
<span id="L95"><span class="lineNum">      95</span>                 :             :    * @param target The address that will receive the underlying, if any</span>
<span id="L96"><span class="lineNum">      96</span>                 :             :    * @param amount The amount getting burned</span>
<span id="L97"><span class="lineNum">      97</span>                 :             :    * @param index The variable debt index of the reserve</span>
<span id="L98"><span class="lineNum">      98</span>                 :             :    */</span>
<span id="L99"><span class="lineNum">      99</span>                 :<span class="tlaGNC">       18095 :   function _burnScaled(address user, address target, uint256 amount, uint256 index) internal {</span></span>
<span id="L100"><span class="lineNum">     100</span>                 :<span class="tlaGNC">       54285 :     uint256 amountScaled = amount.rayDiv(index);</span></span>
<span id="L101"><span class="lineNum">     101</span>                 :<span class="tlaGNC">       36190 :     require(amountScaled != 0, Errors.INVALID_BURN_AMOUNT);</span></span>
<span id="L102"><span class="lineNum">     102</span>                 :             : </span>
<span id="L103"><span class="lineNum">     103</span>                 :<span class="tlaGNC">       54282 :     uint256 scaledBalance = super.balanceOf(user);</span></span>
<span id="L104"><span class="lineNum">     104</span>                 :<span class="tlaGNC">       72376 :     uint256 balanceIncrease = scaledBalance.rayMul(index) -</span></span>
<span id="L105"><span class="lineNum">     105</span>                 :<span class="tlaGNC">       36188 :       scaledBalance.rayMul(_userState[user].additionalData);</span></span>
<span id="L106"><span class="lineNum">     106</span>                 :             : </span>
<span id="L107"><span class="lineNum">     107</span>                 :<span class="tlaGNC">       36188 :     _userState[user].additionalData = index.toUint128();</span></span>
<span id="L108"><span class="lineNum">     108</span>                 :             : </span>
<span id="L109"><span class="lineNum">     109</span>                 :<span class="tlaGNC">       36188 :     _burn(user, amountScaled.toUint128());</span></span>
<span id="L110"><span class="lineNum">     110</span>                 :             : </span>
<span id="L111"><span class="lineNum">     111</span>                 :<span class="tlaGNC">       36186 :     if (balanceIncrease &gt; amount) {</span></span>
<span id="L112"><span class="lineNum">     112</span>                 :<span class="tlaGNC">        4416 :       uint256 amountToMint = balanceIncrease - amount;</span></span>
<span id="L113"><span class="lineNum">     113</span>                 :<span class="tlaGNC">        2944 :       emit Transfer(address(0), user, amountToMint);</span></span>
<span id="L114"><span class="lineNum">     114</span>                 :<span class="tlaGNC">        2944 :       emit Mint(user, user, amountToMint, balanceIncrease, index);</span></span>
<span id="L115"><span class="lineNum">     115</span>                 :             :     } else {</span>
<span id="L116"><span class="lineNum">     116</span>                 :<span class="tlaGNC">       49863 :       uint256 amountToBurn = amount - balanceIncrease;</span></span>
<span id="L117"><span class="lineNum">     117</span>                 :<span class="tlaGNC">       33242 :       emit Transfer(user, address(0), amountToBurn);</span></span>
<span id="L118"><span class="lineNum">     118</span>                 :<span class="tlaGNC">       33242 :       emit Burn(user, target, amountToBurn, balanceIncrease, index);</span></span>
<span id="L119"><span class="lineNum">     119</span>                 :             :     }</span>
<span id="L120"><span class="lineNum">     120</span>                 :             :   }</span>
<span id="L121"><span class="lineNum">     121</span>                 :             : </span>
<span id="L122"><span class="lineNum">     122</span>                 :             :   /**</span>
<span id="L123"><span class="lineNum">     123</span>                 :             :    * @notice Implements the basic logic to transfer scaled balance tokens between two users</span>
<span id="L124"><span class="lineNum">     124</span>                 :             :    * @dev It emits a mint event with the interest accrued per user</span>
<span id="L125"><span class="lineNum">     125</span>                 :             :    * @param sender The source address</span>
<span id="L126"><span class="lineNum">     126</span>                 :             :    * @param recipient The destination address</span>
<span id="L127"><span class="lineNum">     127</span>                 :             :    * @param amount The amount getting transferred</span>
<span id="L128"><span class="lineNum">     128</span>                 :             :    * @param index The next liquidity index of the reserve</span>
<span id="L129"><span class="lineNum">     129</span>                 :             :    */</span>
<span id="L130"><span class="lineNum">     130</span>                 :<span class="tlaGNC">        7051 :   function _transfer(address sender, address recipient, uint256 amount, uint256 index) internal {</span></span>
<span id="L131"><span class="lineNum">     131</span>                 :<span class="tlaGNC">       21153 :     uint256 senderScaledBalance = super.balanceOf(sender);</span></span>
<span id="L132"><span class="lineNum">     132</span>                 :<span class="tlaGNC">       28204 :     uint256 senderBalanceIncrease = senderScaledBalance.rayMul(index) -</span></span>
<span id="L133"><span class="lineNum">     133</span>                 :<span class="tlaGNC">       14102 :       senderScaledBalance.rayMul(_userState[sender].additionalData);</span></span>
<span id="L134"><span class="lineNum">     134</span>                 :             : </span>
<span id="L135"><span class="lineNum">     135</span>                 :<span class="tlaGNC">       21153 :     uint256 recipientScaledBalance = super.balanceOf(recipient);</span></span>
<span id="L136"><span class="lineNum">     136</span>                 :<span class="tlaGNC">       28204 :     uint256 recipientBalanceIncrease = recipientScaledBalance.rayMul(index) -</span></span>
<span id="L137"><span class="lineNum">     137</span>                 :<span class="tlaGNC">       14102 :       recipientScaledBalance.rayMul(_userState[recipient].additionalData);</span></span>
<span id="L138"><span class="lineNum">     138</span>                 :             : </span>
<span id="L139"><span class="lineNum">     139</span>                 :<span class="tlaGNC">       14102 :     _userState[sender].additionalData = index.toUint128();</span></span>
<span id="L140"><span class="lineNum">     140</span>                 :<span class="tlaGNC">       14102 :     _userState[recipient].additionalData = index.toUint128();</span></span>
<span id="L141"><span class="lineNum">     141</span>                 :             : </span>
<span id="L142"><span class="lineNum">     142</span>                 :<span class="tlaGNC">       14102 :     super._transfer(sender, recipient, amount.rayDiv(index).toUint128());</span></span>
<span id="L143"><span class="lineNum">     143</span>                 :             : </span>
<span id="L144"><span class="lineNum">     144</span>                 :<span class="tlaGNC">       14102 :     if (senderBalanceIncrease &gt; 0) {</span></span>
<span id="L145"><span class="lineNum">     145</span>                 :<span class="tlaGNC">        2006 :       emit Transfer(address(0), sender, senderBalanceIncrease);</span></span>
<span id="L146"><span class="lineNum">     146</span>                 :<span class="tlaGNC">        2006 :       emit Mint(_msgSender(), sender, senderBalanceIncrease, senderBalanceIncrease, index);</span></span>
<span id="L147"><span class="lineNum">     147</span>                 :             :     }</span>
<span id="L148"><span class="lineNum">     148</span>                 :             : </span>
<span id="L149"><span class="lineNum">     149</span>                 :<span class="tlaGNC">       28202 :     if (sender != recipient &amp;&amp; recipientBalanceIncrease &gt; 0) {</span></span>
<span id="L150"><span class="lineNum">     150</span>                 :<span class="tlaGNC">           2 :       emit Transfer(address(0), recipient, recipientBalanceIncrease);</span></span>
<span id="L151"><span class="lineNum">     151</span>                 :<span class="tlaGNC">           2 :       emit Mint(_msgSender(), recipient, recipientBalanceIncrease, recipientBalanceIncrease, index);</span></span>
<span id="L152"><span class="lineNum">     152</span>                 :             :     }</span>
<span id="L153"><span class="lineNum">     153</span>                 :             : </span>
<span id="L154"><span class="lineNum">     154</span>                 :<span class="tlaGNC">       14102 :     emit Transfer(sender, recipient, amount);</span></span>
<span id="L155"><span class="lineNum">     155</span>                 :             :   }</span>
<span id="L156"><span class="lineNum">     156</span>                 :             : }</span>
        </pre>
              </td>
            </tr>
          </table>
          <br>

          <table width="100%" border=0 cellspacing=0 cellpadding=0>
            <tr><td class="ruler"><img src="../../../../../../../../../../../glass.png" width=3 height=3 alt=""></td></tr>
            <tr><td class="versionInfo">Generated by: <a href="https://github.com//linux-test-project/lcov" target="_parent">LCOV version 2.0-1</a></td></tr>
          </table>
          <br>

</body>
</html>
